home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dstein.z / dstein
Encoding:
Text File  |  2002-10-03  |  5.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4. DDDDSSSSTTTTEEEEIIIINNNN((((3333SSSS))))                                                          DDDDSSSSTTTTEEEEIIIINNNN((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DSTEIN - compute the eigenvectors of a real symmetric tridiagonal matrix
  10.      T corresponding to specified eigenvalues, using inverse iteration
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE DSTEIN( N, D, E, M, W, IBLOCK, ISPLIT, Z, LDZ, WORK, IWORK,
  14.                         IFAIL, INFO )
  15.  
  16.          INTEGER        INFO, LDZ, M, N
  17.  
  18.          INTEGER        IBLOCK( * ), IFAIL( * ), ISPLIT( * ), IWORK( * )
  19.  
  20.          DOUBLE         PRECISION D( * ), E( * ), W( * ), WORK( * ), Z( LDZ, *
  21.                         )
  22.  
  23. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  24.      These routines are part of the SCSL Scientific Library and can be loaded
  25.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  26.      directs the linker to use the multi-processor version of the library.
  27.  
  28.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  29.      4 bytes (32 bits). Another version of SCSL is available in which integers
  30.      are 8 bytes (64 bits).  This version allows the user access to larger
  31.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  32.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  33.      only one of the two versions; 4-byte integer and 8-byte integer library
  34.      calls cannot be mixed.
  35.  
  36. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  37.      DSTEIN computes the eigenvectors of a real symmetric tridiagonal matrix T
  38.      corresponding to specified eigenvalues, using inverse iteration. The
  39.      maximum number of iterations allowed for each eigenvector is specified by
  40.      an internal parameter MAXITS (currently set to 5).
  41.  
  42.  
  43. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  44.      N       (input) INTEGER
  45.              The order of the matrix.  N >= 0.
  46.  
  47.      D       (input) DOUBLE PRECISION array, dimension (N)
  48.              The n diagonal elements of the tridiagonal matrix T.
  49.  
  50.      E       (input) DOUBLE PRECISION array, dimension (N)
  51.              The (n-1) subdiagonal elements of the tridiagonal matrix T, in
  52.              elements 1 to N-1.  E(N) need not be set.
  53.  
  54.      M       (input) INTEGER
  55.              The number of eigenvectors to be found.  0 <= M <= N.
  56.  
  57.      W       (input) DOUBLE PRECISION array, dimension (N)
  58.              The first M elements of W contain the eigenvalues for which
  59.              eigenvectors are to be computed.  The eigenvalues should be
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDSSSSTTTTEEEEIIIINNNN((((3333SSSS))))                                                          DDDDSSSSTTTTEEEEIIIINNNN((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              grouped by split-off block and ordered from smallest to largest
  75.              within the block.  ( The output array W from DSTEBZ with ORDER =
  76.              'B' is expected here. )
  77.  
  78.      IBLOCK  (input) INTEGER array, dimension (N)
  79.              The submatrix indices associated with the corresponding
  80.              eigenvalues in W; IBLOCK(i)=1 if eigenvalue W(i) belongs to the
  81.              first submatrix from the top, =2 if W(i) belongs to the second
  82.              submatrix, etc.  ( The output array IBLOCK from DSTEBZ is
  83.              expected here. )
  84.  
  85.      ISPLIT  (input) INTEGER array, dimension (N)
  86.              The splitting points, at which T breaks up into submatrices.  The
  87.              first submatrix consists of rows/columns 1 to ISPLIT( 1 ), the
  88.              second of rows/columns ISPLIT( 1 )+1 through ISPLIT( 2 ), etc.  (
  89.              The output array ISPLIT from DSTEBZ is expected here. )
  90.  
  91.      Z       (output) DOUBLE PRECISION array, dimension (LDZ, M)
  92.              The computed eigenvectors.  The eigenvector associated with the
  93.              eigenvalue W(i) is stored in the i-th column of Z.  Any vector
  94.              which fails to converge is set to its current iterate after
  95.              MAXITS iterations.
  96.  
  97.      LDZ     (input) INTEGER
  98.              The leading dimension of the array Z.  LDZ >= max(1,N).
  99.  
  100.      WORK    (workspace) DOUBLE PRECISION array, dimension (5*N)
  101.  
  102.      IWORK   (workspace) INTEGER array, dimension (N)
  103.  
  104.      IFAIL   (output) INTEGER array, dimension (M)
  105.              On normal exit, all elements of IFAIL are zero.  If one or more
  106.              eigenvectors fail to converge after MAXITS iterations, then their
  107.              indices are stored in array IFAIL.
  108.  
  109.      INFO    (output) INTEGER
  110.              = 0: successful exit.
  111.              < 0: if INFO = -i, the i-th argument had an illegal value
  112.              > 0: if INFO = i, then i eigenvectors failed to converge in
  113.              MAXITS iterations.  Their indices are stored in array IFAIL.
  114.  
  115. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  116.      MAXITS  INTEGER, default = 5
  117.              The maximum number of iterations performed.
  118.  
  119.      EXTRA   INTEGER, default = 2
  120.              The number of iterations performed after norm growth criterion is
  121.              satisfied, should be at least 1.
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDSSSSTTTTEEEEIIIINNNN((((3333SSSS))))                                                          DDDDSSSSTTTTEEEEIIIINNNN((((3333SSSS))))
  137.  
  138.  
  139.  
  140. SEE ALSO
  141.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  142.  
  143.      This man page is available only online.
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.